<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
    <title>RaxanDataSanitizer | Raxan User Guide</title>
    <link href="../raxan/styles/master.css" rel="stylesheet" type="text/css" />
    <!--[if IE]><link rel="stylesheet" href="../raxan/styles/master.ie.css" type="text/css"><![endif]-->
    <link href="style.css" rel="stylesheet" type="text/css" />
    <link href="highlight/styles/default.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" src="highlight/highlight.js"></script>
    <script type="text/javascript">
        hljs.initHighlightingOnLoad('javascript','html','php');
    </script>

</head>

<body>
    <div class="container c48 prepend-top">
        <h2 class="bottom">Raxan User Guide</h2>
        <div class="navbar">
            <div class="lf"><div class="rt"><div class="md">
                <ul>
                    <li><a href="../index.html" title="The Rich Ajax, CSS &amp; PHP Framework" >Home</a></li>
                    <li><a href="table-of-contents.html" title="Blog Posts" >Table Of Contents</a></li>
                    <li><a href="../php-examples/index.php" title="PHP Examples" >PHP Examples</a></li>
                    <li><a href="../css-examples/index.html" title="User Guide" >CSS Examples</a></li>
                </ul>
            </div></div></div>
        </div>
        <div class="prepend1 append1">
            <div class="ltm" align="right">
                <a href="table-of-contents.html" title="Show Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
            <div class="container c45">

    <h2 class="class-name">Class RaxanDataSanitizer</h2>

    <a name="sec-description"></a>
    <div class="box bmm">
        <div class="box-title">Description</div>
        <div class="nav-bar">
            <span class="disabled">Description</span> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            |                                                            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <!-- ========== Info from phpDoc block ========= -->
            <p class="short-description">Provides APIs to filter and sanitizer user inputs and file uploads</p>
            <p class="notes">
                Located in <a class="field" href="#">raxan/pdi/shared/raxan.datasanitizer.php</a> (line <span class="field">6</span>)
            </p>


            <pre></pre>

        </div>
    </div>



    <a name="sec-var-summary"></a>
    <div class="box bmm">
        <div class="box-title">Variable Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <div class="var-summary">
                <div class="var-title">
                    static <span class="var-type">mixed</span>
                    <a href="#$badCharacters" title="details" class="var-name">$badCharacters</a>
                </div>
                <div class="var-title">
                    static <span class="var-type">$iDate</span>
                    <a href="#$validators" title="details" class="var-name">$validators</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$charset" title="details" class="var-name">$charset</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$iData" title="details" class="var-name">$iData</a>
                </div>
                <div class="var-title">
                    <span class="var-type">mixed</span>
                    <a href="#$iDate" title="details" class="var-name">$iDate</a>
                </div>
            </div>
        </div>
    </div>

    <a name="sec-method-summary"></a>
    <div class="box bmm">
        <div class="box-title">Method Summary</span></div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)

            |
            <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
        </div>
        <div class="box bmm-body">
            <div class="method-summary">
                <div class="method-definition">
                    static                             <span class="method-result">null</span>
                    <a href="#addDataValidator" title="details" class="method-name">addDataValidator</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
                </div>

                <div class="method-definition">
                    <span class="method-result">RaxanDataSanitizer</span>
                    <a href="#__construct" title="details" class="method-name">__construct</a>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$array</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$charset</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#addValidator" title="details" class="method-name">addValidator</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#date" title="details" class="method-name">date</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#email" title="details" class="method-name">email</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#escape" title="details" class="method-name">escape</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#fileContent" title="details" class="method-name">fileContent</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#fileCopy" title="details" class="method-name">fileCopy</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dest</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Integer</span>
                    <a href="#fileCount" title="details" class="method-name">fileCount</a>
                    ()
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#fileImageResample" title="details" class="method-name">fileImageResample</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$w</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Array</span>
                    <a href="#fileImageSize" title="details" class="method-name">fileImageSize</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#fileMove" title="details" class="method-name">fileMove</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dest</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#fileOrigName" title="details" class="method-name">fileOrigName</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Integer</span>
                    <a href="#fileSize" title="details" class="method-name">fileSize</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#fileType" title="details" class="method-name">fileType</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Float</span>
                    <a href="#float" title="details" class="method-name">float</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#html" title="details" class="method-name">html</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$allowable</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$allowStyle</span> = <span class="var-default">true</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Integer</span>
                    <a href="#integer" title="details" class="method-name">integer</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#isDate" title="details" class="method-name">isDate</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#isEmail" title="details" class="method-name">isEmail</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#isNumeric" title="details" class="method-name">isNumeric</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Boolean</span>
                    <a href="#isUrl" title="details" class="method-name">isUrl</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">Integer</span>
                    <a href="#length" title="details" class="method-name">length</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#money" title="details" class="method-name">money</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#number" title="details" class="method-name">number</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#setDataArray" title="details" class="method-name">setDataArray</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$array</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#text" title="details" class="method-name">text</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$length</span> = <span class="var-default">null</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Integer</span>
                    <a href="#timestamp" title="details" class="method-name">timestamp</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#url" title="details" class="method-name">url</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$encoded</span> = <span class="var-default">false</span>])
                </div>
                <div class="method-definition">
                    <span class="method-result">Mixed</span>
                    <a href="#value" title="details" class="method-name">value</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">void</span>
                    <a href="#__call" title="details" class="method-name">__call</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
                </div>
                <div class="method-definition">
                    <span class="method-result">String</span>
                    <a href="#__get" title="details" class="method-name">__get</a>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
                </div>
            </div>
        </div>
    </div>

    <a name="sec-vars"></a>
    <div class="box bmm">
        <div class="box-title">Variables</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)


            |
            <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)

        </div>
        <div class="box bmm-body">
            <a name="var$badCharacters" id="$badCharacters"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        static <span class="var-type">mixed</span>
                        <span class="var-name">$badCharacters</span>
                        = <span class="var-default">array(&quot;\r&quot;,&quot;\n&quot;,&quot;\t&quot;,&quot;\x00&quot;,&quot;\x1a&quot;)</span>            (line <span class="line-number">11</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$validators" id="$validators"><!-- --></a>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        static <span class="var-type">$iDate</span>
                        <span class="var-name">$validators</span>
                        = <span class="var-default">array()</span>            (line <span class="line-number">10</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">var:</span> RaxanDateTime</li>
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$charset" id="$charset"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$charset</span>
                        (line <span class="line-number">15</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$iData" id="$iData"><!-- --></a>
            <div class="evenrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$iData</span>
                        (line <span class="line-number">13</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>
            <a name="var$iDate" id="$iDate"><!-- --></a>
            <div class="oddrow">

                <div class="var-header">
                    <span class="var-title">
                        <span class="var-type">mixed</span>
                        <span class="var-name">$iDate</span>
                        (line <span class="line-number">14</span>)
                    </span>
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> protected</li>
                </ul>





            </div>

        </div>
    </div>

    <a name="sec-methods"></a>
    <div class="box bmm">
        <div class="box-title">Methods</div>
        <div class="nav-bar">
            <a href="#sec-description">Description</a> |
            <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
            <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)

        </div>
        <div class="box bmm-body">
            <a name='method_detail'></a>
            <a name="methodaddDataValidator" id="addDataValidator"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">static addDataValidator</span> (line <span class="line-number">363</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Adds a custom data validator using regex patterns or callback function</p>
                <p class="description"><p>A callback function can be used as in place of a $pattern</p></p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    static <span class="method-result">null</span>
                    <span class="method-name">
                        addDataValidator
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$name</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$pattern</span>            </li>
                </ul>


            </div>
            <a name="method__construct" id="__construct"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">Constructor __construct</span> (line <span class="line-number">18</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">RaxanDataSanitizer</span>
                    <span class="method-name">
                        __construct
                    </span>
                    ([<span class="var-type"></span>&nbsp;<span class="var-name">$array</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$charset</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$array</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$charset</span>            </li>
                </ul>


            </div>
            <a name="methodaddValidator" id="addValidator"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">addValidator</span> (line <span class="line-number">62</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Adds a custom data validator using regex patterns or callback function</p>
                <p class="description"><p>Used as a wrapper to addDataValidator</p></p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        addValidator
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$name</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$pattern</span>            </li>
                </ul>


            </div>
            <a name="methoddate" id="date"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">date</span> (line <span class="line-number">70</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns formated date value</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        date
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$format</span>            </li>
                </ul>


            </div>
            <a name="methodemail" id="email"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">email</span> (line <span class="line-number">98</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns sanitized email address for the selected field</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        email
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodescape" id="escape"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">escape</span> (line <span class="line-number">106</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns html escaped value for the selected field</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        escape
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodfileContent" id="fileContent"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">fileContent</span> (line <span class="line-number">151</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the content of an uploaded file based on the selected field name</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        fileContent
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                </ul>


            </div>
            <a name="methodfileCopy" id="fileCopy"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">fileCopy</span> (line <span class="line-number">160</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Copies an uploaded files (based on the selected field name) to the specified destination.</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        fileCopy
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dest</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$dest</span>            </li>
                </ul>


            </div>
            <a name="methodfileCount" id="fileCount"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">fileCount</span> (line <span class="line-number">170</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns a total number of file uploaded</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Integer</span>
                    <span class="method-name">
                        fileCount
                    </span>
                    ()
                </div>



            </div>
            <a name="methodfileImageResample" id="fileImageResample"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">fileImageResample</span> (line <span class="line-number">188</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Resamples (convert/resize) the uploaded image. You can specify a new width, height and type</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        fileImageResample
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$w</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$h</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$w</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$h</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$type</span>            </li>
                </ul>


            </div>
            <a name="methodfileImageSize" id="fileImageSize"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">fileImageSize</span> (line <span class="line-number">178</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns an array containing the width, height and type for the uploaded image file</p>
                <ul class="tags">
                    <li><span class="field">return:</span> or NULL if error</li>
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Array</span>
                    <span class="method-name">
                        fileImageSize
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodfileMove" id="fileMove"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">fileMove</span> (line <span class="line-number">198</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Moves an uploaded files (based on the selected field name) to the specified destination.</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        fileMove
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$dest</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$dest</span>            </li>
                </ul>


            </div>
            <a name="methodfileOrigName" id="fileOrigName"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">fileOrigName</span> (line <span class="line-number">209</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the original name of the uploaded file based on the selected field name</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        fileOrigName
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                </ul>


            </div>
            <a name="methodfileSize" id="fileSize"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">fileSize</span> (line <span class="line-number">218</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the size of the uploaded file based on the selected field name</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Integer</span>
                    <span class="method-name">
                        fileSize
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                </ul>


            </div>
            <a name="methodfileType" id="fileType"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">fileType</span> (line <span class="line-number">226</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the file type (as reported by browser) of an uploaded file based on the selected field name</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        fileType
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$fld</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$fld</span>            </li>
                </ul>


            </div>
            <a name="methodfloat" id="float"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">float</span> (line <span class="line-number">114</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns float value</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Float</span>
                    <span class="method-name">
                        float
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$decimal</span>            </li>
                </ul>


            </div>
            <a name="methodhtml" id="html"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">html</span> (line <span class="line-number">123</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns sanitized html by removing javascript tags and inline events</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        html
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$allowable</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$allowStyle</span> = <span class="var-default">true</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$allowable</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$allowStyle</span>            </li>
                </ul>


            </div>
            <a name="methodinteger" id="integer"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">integer</span> (line <span class="line-number">234</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns integer value</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Integer</span>
                    <span class="method-name">
                        integer
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodisDate" id="isDate"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">isDate</span> (line <span class="line-number">242</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns true if the selected field is a valid date entry</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        isDate
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$format</span>            </li>
                </ul>


            </div>
            <a name="methodisEmail" id="isEmail"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">isEmail</span> (line <span class="line-number">254</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns true if the selected field is a valid email address</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        isEmail
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodisNumeric" id="isNumeric"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">isNumeric</span> (line <span class="line-number">265</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns true if the selected field is numeric</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        isNumeric
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodisUrl" id="isUrl"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">isUrl</span> (line <span class="line-number">273</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns true if the selected field is numeric</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Boolean</span>
                    <span class="method-name">
                        isUrl
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodlength" id="length"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">length</span> (line <span class="line-number">289</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the length of the speicifed field value</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Integer</span>
                    <span class="method-name">
                        length
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodmoney" id="money"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">money</span> (line <span class="line-number">297</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns formatted money value based on locale settings</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        money
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$decimal</span>            </li>
                </ul>


            </div>
            <a name="methodnumber" id="number"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">number</span> (line <span class="line-number">312</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns formatted number value based on locale settings</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        number
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$decimal</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$decimal</span>            </li>
                </ul>


            </div>
            <a name="methodsetDataArray" id="setDataArray"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">setDataArray</span> (line <span class="line-number">26</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Sets the array source for the sanitizer</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        setDataArray
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$array</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$array</span>            </li>
                </ul>


            </div>
            <a name="methodtext" id="text"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">text</span> (line <span class="line-number">322</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Remove html tags</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        text
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$length</span> = <span class="var-default">null</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$length</span>            </li>
                </ul>


            </div>
            <a name="methodtimestamp" id="timestamp"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">timestamp</span> (line <span class="line-number">332</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns timestamp</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Integer</span>
                    <span class="method-name">
                        timestamp
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="methodurl" id="url"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">url</span> (line <span class="line-number">341</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns sanitized url for the selected field</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        url
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$encoded</span> = <span class="var-default">false</span>])
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$encoded</span>            </li>
                </ul>


            </div>
            <a name="methodvalue" id="value"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">value</span> (line <span class="line-number">350</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns a value  based on the specified key</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">Mixed</span>
                    <span class="method-name">
                        value
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$key</span>            </li>
                </ul>


            </div>
            <a name="method__call" id="__call"><!-- --></a>
            <div class="evenrow">

                <div class="method-header">
                    <span class="method-title">__call</span> (line <span class="line-number">31</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">void</span>
                    <span class="method-name">
                        __call
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$args</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$name</span>            </li>
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$args</span>            </li>
                </ul>


            </div>
            <a name="method__get" id="__get"><!-- --></a>
            <div class="oddrow">

                <div class="method-header">
                    <span class="method-title">__get</span> (line <span class="line-number">54</span>)
                </div>

                <!-- ========== Info from phpDoc block ========= -->
                <p class="short-description">Returns the sanitized text for the specified key. All html charcters will be removed.</p>
                <ul class="tags">
                    <li><span class="field">access:</span> public</li>
                </ul>

                <div class="method-signature">
                    <span class="method-result">String</span>
                    <span class="method-name">
                        __get
                    </span>
                    (<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>)
                </div>

                <ul class="parameters">
                    <li>
                        <span class="var-type"></span>
                        <span class="var-name">$name</span>            </li>
                </ul>


            </div>

        </div>
    </div>

</div>

        </div>
        <div class="tpb pad" style="text-align:right">
            <div class="right ltm">
                <a href="table-of-contents.html" title="Back to Table of Content">
                    <img src="images/toc-button.png"  alt="Table of Contents" />
                </a>
            </div>
        </div>
    </div>
</body>

</html>

